Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lint Markdown files, fix headings style #99

Merged
merged 1 commit into from
May 25, 2024
Merged

Lint Markdown files, fix headings style #99

merged 1 commit into from
May 25, 2024

Conversation

its-miroma
Copy link
Member

@its-miroma its-miroma commented May 11, 2024 •
edited
Loading

Linting

  • Remove trailing whitespace
  • Single newline at the end of each file
  • Remove unnecessary quotes in frontmatters
  • Use relative link for CONTRIBUTING.md
  • Update sidebar_translations.json
  • Increment headings one level at a time
  • Remove punctuation from headings, except exclamation marks

Headings

Other

@its-miroma its-miroma requested a review from a team as a code owner May 11, 2024 14:11
@netlify Netlify
Copy link

netlify bot commented May 11, 2024 •
edited
Loading

✅ Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit 82dd085
🔍 Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/6641d335187acd00089dabc8
😎 Deploy Preview https://deploy-preview-99--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@IMB11
Copy link
Member

IMB11 commented May 11, 2024

Maybe it's worth integrating a markdown lint action/tool - I didn't originally suggest one because to be frank they all suck. There isn't really any good linters out there that:

  • Automatic fix markdown issues using a CLI command.
  • Aren't annoying to configure and understand lint errors.

@its-miroma
Copy link
Member Author

its-miroma commented May 11, 2024 •
edited
Loading

I personally use markdownlint by David Anson, which has a VS Code extension
and a cli.

It works pretty well and supports custom rules; there probably are some for
Title Case as well.

Its rules are pretty strict, I'd recommend disabling MD025 and MD026
(with punctuation: ".,;:。，；：").

@its-miroma
Copy link
Member Author

There even is a GitHub Action, although I have to admit I'm not super
familiar with that

@its-miroma
Copy link
Member Author

its-miroma commented May 12, 2024 •
edited
Loading

I personally use markdownlint by David Anson, which has a VS Code extension and a cli.

There even is a GitHub Action, although I have to admit I'm not super familiar with that

Please review #101

@IMB11 IMB11 added improvement A new addition to an already existing page framework Related to the website's framework (Vitepress) labels May 12, 2024
@its-miroma its-miroma mentioned this pull request May 12, 2024
Merged
modmuss50
modmuss50 previously approved these changes May 13, 2024
View reviewed changes
@its-miroma
Lint Markdown files, fix headings style
82dd085 
- Remove trailing whitespace
- Single newline at the end of each file
- Remove unnecessary quotes in frontmatters
- Use relative link for [CONTRIBUTING.md]
- Update [sidebar_translations.json]
- Increment headings one level at a time
- Remove punctuation from headings, except exclamation marks

- Use Title Case through <https://www.titlecase.com/>
- Questions are exempted

- Capitalize various instances of "Java", "Loader", "Loom"
- Add custom heading link in [codecs.md]
- Avoid using emphasis for headings in [effects.md]
  - Side Effect: the auto-generated TOC now shows those two headings
- Change info box in [potions.md] (may fix #89)
- Add alt text to image in [hud.md]
- Avoid using invisible spaces for a line break in [creating-particles.md]
- Capitalize alt texts in [custom.md]

[CONTRIBUTING.md]: </CONTRIBUTING.md>
[sidebar_translations.json]: </sidebar_translations.json>
[codecs.md]: </develop/codecs.md#mapcodec>
[effects.md]: </develop/entities/effects.md>
[potions.md]: </develop/items/potions.md>
[hud.md]: </develop/rendering/hud.md>
[creating-particles.md]: </develop/rendering/particles/creating-particles.md>
[custom.md]: </develop/sounds/custom.md>
@IMB11 IMB11 merged commit 2e3e269 into FabricMC:main May 25, 2024
6 checks passed
@its-miroma its-miroma deleted the lint branch May 25, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IMB11 IMB11 IMB11 approved these changes

@modmuss50 modmuss50 modmuss50 left review comments

Assignees
No one assigned
Labels
framework Related to the website's framework (Vitepress) improvement A new addition to an already existing page
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

A string is not translatable in develop/items/potions.md
3 participants
@its-miroma @IMB11 @modmuss50